Vapi Std Errors Unauthenticated
The Vapi Std Errors Unauthenticated error indicates that the operation requires authentication and the user is not authenticated.
API requests may include a security context containing user credentials. For example, the user credentials could be a SAML token, a user name and password, or the session identifier for a previously established session.
Examples:
- The SAML token in the request's security context has expired.
- The user name and password in the request's security context are invalid.
- The session identifier in the request's security context identifies a session that has expired. Counterexamples:
- The user is authenticated but isn't authorized to perform the requested operation. The Vapi Std Errors Unauthorized error would be used instead.
For security reasons, the Vapi Std Errors Error.data property in this error is missing or null
, and the Vapi Std Errors Error.messages property in this error does not disclose which part of the security context is correct or incorrect. For example the messages would not disclose whether a username or a password is valid or invalid, but only that a combination of username and password is invalid.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string",
"challenge": "string"
}
Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.